/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2013 ForgeRock Inc.
 */
package org.forgerock.openam.entitlement.indextree;

/**
 * Responsible for starting a listener, such as some persistent search, to listen for change within the data source
 * where indexes are stored.
 *
 * @author andrew.forrest@forgerock.com
 */
public interface IndexChangeMonitor {

    /**
     * Start the listener to monitor for index changes.
     *
     * @throws ChangeMonitorException
     *         Should some error occur when attempting to start the listener.
     */
    public void start() throws ChangeMonitorException;

    /**
     * Informs the monitor to shutdown.
     */
    public void shutdown();

}
